/*
 * The MIT License
 *
 * Copyright 2014 David Rodenas Pico.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package edu.uoc.sd.fr14.mesg;

import edu.uoc.sd.fr14.actors.Server;

/**
 *
 * @author drodenas
 */
public abstract class TimeoutMessage extends TargetedMessage implements MessageForServer {

	private static final long serialVersionUID = -7498380536444900325L;
	private volatile boolean canceled;
    private final Finally finish;

    public TimeoutMessage(TargetId target, Finally onFinally) {
        super(target);
        if (onFinally == null) throw new NullPointerException("Illegal argument: finished cannot be null");
        
        this.finish = onFinally;
    }
    
    
    public void cancel() {
        canceled = true;
    }
    
    public boolean isCanceled() {
        return canceled;
    }
    
    @Override
    public final void apply(Server server) {
        boolean success = false;
        try {
            if (!canceled) {
                this.safeApply(server);
                success = true;
            }
        } finally {
            finish.finish(this, success);
        }
    }

    /**
     * Ensures that the timeout is not canceled.
     * <p>
     * Assumes that apply is called in an exclusive region affected by the same 
     * actor that sets the timeout.
     * 
     * @param server 
     */
    public abstract void safeApply(Server server);

    @Override
    public String toString() {
        if (!canceled) {
            return ">[ ]>"+getTarget();
        } else {
            return ">...X"+getTarget();
        }
    }
    

    public static final Finally NOTHING = new Finally() {
        @Override
        public void finish(TimeoutMessage me, boolean success) {
        }
    };
    
    public static interface Finally {
        void finish(TimeoutMessage me, boolean success);
    }
    
}
